home *** CD-ROM | disk | FTP | other *** search
/ Stone Design / Stone Design.iso / Stone_Friends / Wave / WavesWorld / Source / Libraries / tcl7.4b3 / doc / StrMatch.3 < prev    next >
Encoding:
Text File  |  1994-12-17  |  1.1 KB  |  40 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" Copyright (c) 1994 Sun Microsystems, Inc.
  4. '\"
  5. '\" See the file "license.terms" for information on usage and redistribution
  6. '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  7. '\" 
  8. '\" @(#) StrMatch.3 1.8 94/12/17 16:17:32
  9. '\" 
  10. .so man.macros
  11. .HS Tcl_StringMatch tclc
  12. .BS
  13. .SH NAME
  14. Tcl_StringMatch \- test whether a string matches a pattern
  15. .SH SYNOPSIS
  16. .nf
  17. \fB#include <tcl.h>\fR
  18. .sp
  19. int
  20. \fBTcl_StringMatch\fR(\fIstring\fR, \fIpattern\fR)
  21. .SH ARGUMENTS
  22. .AP char *string in
  23. String to test.
  24. .AP char *pattern in
  25. Pattern to match against string.  May contain special
  26. characters from the set *?\e[].
  27. .BE
  28.  
  29. .SH DESCRIPTION
  30. .PP
  31. This utility procedure determines whether a string matches
  32. a given pattern.  If it does, then \fBTcl_StringMatch\fR returns
  33. 1.  Otherwise \fBTcl_StringMatch\fR returns 0.  The algorithm
  34. used for matching is the same algorithm used in the ``string match''
  35. Tcl command and is similar to the algorithm used by the C-shell
  36. for file name matching;  see the Tcl manual entry for details.
  37.  
  38. .SH KEYWORDS
  39. match, pattern, string
  40.